Esx Settings Defaults Clusters Policies Apply Effective EffectivePolicySpec
The Esx Settings Defaults Clusters Policies Apply Effective EffectivePolicySpec schema contains properties that describe the effective policies to be used when the software and configuration specification documents are applied to ESXi clusters.
This schema was added in vSphere API 7.0.0.0.
{
"failure_action": {
"action": "string",
"retry_delay": 0,
"retry_count": 0
},
"pre_remediation_power_action": "string",
"enable_quick_boot": false,
"disable_dpm": false,
"disable_hac": false,
"evacuate_offline_vms": false,
"enforce_hcl_validation": false,
"parallel_remediation_action": {
"enabled": false,
"max_hosts": 0
},
"enforce_quick_patch": false,
"software_policy_spec": {
"enforce_hcl_validation": false,
"parallel_remediation_action": {
"enabled": false,
"max_hosts": 0
},
"live_patch_action": {
"live_patch_mode": "string"
},
"skip_reserved_vibs_caching": false
},
"config_manager_policy_spec": {
"serial_remediation": false,
"auto_remediate_on_host_add": false
}
}What action is to be taken if entering maintenance mode fails on a given host of the cluster.
This property was added in vSphere API 7.0.0.0.
Specifies what should be done to the power state of the VM before entering maintenance mode.
For more information see: Esx Settings Defaults Clusters Policies Apply Effective EffectivePolicySpec PreRemediationPowerAction.
This property was added in vSphere API 7.0.0.0.
Enable Quick Boot during remediation in the cluster.
This property was added in vSphere API 7.0.0.0.
Disable DPM on the cluster.
This property was added in vSphere API 7.0.0.0.
Disable HA Admission control on the cluster.
This property was added in vSphere API 7.0.0.0.
Evacuate powered off/suspended VMs when attempting maintenance mode.
This property was added in vSphere API 7.0.0.0.
Enforce HCL validation, when applicable, to prevent remediation if hardware compatibility issues are found. This field will be deprecated in the future. It is recommended to set the corresponding field in Esx Settings Defaults Clusters Policies Apply Effective EffectivePolicySpec.software_policy_spec instead.
This property was added in vSphere API 7.0.1.0.
This property is optional because it was added in a newer version than its parent node.
Enable parallel remediation of hosts in maintenance mode. Set max hosts when applicable.
This property was added in vSphere API 8.0.0.1.
If missing or null, parallel remediation will not happen. This field will be deprecated in the future. It is recommended to set the corresponding field in Esx Settings Defaults Clusters Policies Apply Effective EffectivePolicySpec.software_policy_spec instead.
Enforce quick patch on the cluster for images that support it. This field will be deprecated in the future. When its value is false, it does not necessarily mean Live Patch is disabled. Refer to Effective.EffectivePolicySpec.softwarePolicySpec#livePatchAction, which can be set to use one of several Live Patch modes in addition to enforce Live Patch, for the actual mode that is effective.
This property was added in vSphere API 8.0.3.0.
This property is optional because it was added in a newer version than its parent node.
Software-specific policy settings applicable to the POST /esx/settings/clusters/{cluster}/software?action=apply API.
This property was added in vSphere API 9.1.0.0.
This property is optional because it was added in a newer version than its parent node.
Configure settings applicable to the POST /esx/settings/clusters/{cluster}/configuration?action=apply API.
This property was added in vSphere API 8.0.3.0.
This property is optional because it was added in a newer version than its parent node.